home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / qbbs / fxbull10.zip / FXBULL.DOC < prev    next >
Text File  |  1991-06-01  |  11KB  |  339 lines
  1.                              FXBULL Version 1.00
  2.                              ═══════════════════
  3.  
  4. The Definitive "FLEXIBULL" Bulletins Generator for RA/QBBS Compatible Systems.
  5.  
  6.  
  7. Features :-
  8. -----------
  9.                 o   Generates FIFTEEN Different Bulletins
  10.                 o   Multi-Line Compatible
  11.                 o   RA/QBBS Compatible
  12.                 o   Extremely Configurable
  13.                 o   Can Blacklist specified users
  14.                 o   Can Blacklist specified Message Boards
  15.                 o   Generates ANSI and ASCII Bulletins
  16.                 o   Can Generate SYSOP Message Base Report
  17.  
  18. History :-
  19. ----------
  20.  
  21. I was tired of my previous bulletin generator failing to work on my multi-
  22. line system due to lock-out problems. I also wanted to choose the way the
  23. bulletins appeared. Therefore I designed and programmed this bulletin
  24. generator. 
  25.  
  26.  
  27. Credits :-
  28. ----------
  29.  
  30. Author : Mark Alexander
  31.  
  32.  
  33. Beta Testers :-
  34. ---------------
  35.  
  36. Keith Wassell  (2:440/2)  Networked Multi-Line testing.
  37. Myself         (2:440/52) Desqview Multi-Line testing.
  38. Paul Bonifacio            General thrashing and (can I break it)
  39.  
  40.  
  41.  
  42.  
  43. Getting Started :-
  44. ------------------
  45.  
  46. Choose a directory for FXBULL.EXE and FXBULL.CFG to "live" in.
  47.  
  48. Modify the configuration file to suit your needs (pay special attention to
  49. the "path" parameters).
  50.  
  51. Change Directory to the directory containing BOTH FXBULL.EXE and FXBULL.CFG
  52.  
  53. Run FXBULL.
  54.  
  55. Now examine the generated bulletins. Impressive huh!. So impressive that
  56. I am sure you will feel an overwhelming urge to register this program with
  57. the author (which will entitle you to the Multi-Line Usage Bulletin)
  58.  
  59.  
  60. Take a peek in FXBULL.TIP which contains user usage hints.
  61.  
  62.  
  63.  
  64. The Configuration File :-
  65. -------------------------
  66.  
  67. The supplied configuration file contains a brief summary of the following
  68. parameter statements.
  69.  
  70. Anything in the Configuration file starting with ; is a comment line and
  71. will be ignored by the program.
  72.  
  73. The Smallest workable configuration file would be :-
  74. ----
  75. BBSPATH c:\ra
  76. BULL 1
  77. ---
  78. Which would generate the last callers bulletins in the current directory.
  79. Everything else is optional!
  80.  
  81.  
  82. ────────────────────────────────────────────────────────────────────────────────
  83. BBSNAME (String of CHR$. Max Length 29)
  84.  
  85. This String will appear on every bulletin. Useful for reminding your users
  86. exactly which system they are currently using!
  87.  
  88. Default : FXBULL V1.00
  89.  
  90. Example : BBSNAME MegaPower Multi-Line Bbs
  91.  
  92. N.B. After the 30 day evalution period this defaults to "Evaluation Copy"
  93. ────────────────────────────────────────────────────────────────────────────────
  94. BBSPATH (Filepath)
  95.  
  96. The path to "USERS.BBS"
  97.  
  98. Default : This is a REQUIRED parameter.
  99.  
  100. Example : BBSPATH C:\RA\MSGBASE
  101. ────────────────────────────────────────────────────────────────────────────────
  102. BBSTYPE (RA or QBBS)
  103.  
  104. The type of BBS system (or compatible) in use.
  105. This parameter is only required when generating Message Base Bulletins.
  106. If QBBS is selected then CONFIG.BBS is used.
  107. If RA is selected then MESSAGES.RA is used.
  108.  
  109. Default : RA
  110.  
  111. Example : BBSTYPE RA
  112. ────────────────────────────────────────────────────────────────────────────────
  113. CONPATH (Filepath)
  114.  
  115. The path to "MESSAGES.RA" or "CONFIG.BBS" (see BBSTYPE Parameter above)
  116.  
  117. Default : This is a REQUIRED parameter (if generating Message Base Bulletins)
  118.  
  119. Example : CONPATH C:\RA
  120. ────────────────────────────────────────────────────────────────────────────────
  121. MSGPATH (Filepath)
  122.  
  123. The path to "MSGIDX.BBS"
  124.  
  125. Default : This is a REQUIRED parameter (if generating Message Base Bulletins)
  126.  
  127. Example : MSGPATH C:\RA\MSGBASE
  128. ────────────────────────────────────────────────────────────────────────────────
  129. BULL (Number) (Filepath and Name)
  130.  
  131. This parameter is used to enable bulletin generation.
  132. (Number) is the number of the bulletin to generate (1 to 15)
  133.  1 - Last Callers Bulletin (up to 10 Entries) Sorted DATE and TIME
  134.  2 - Selected Users (by security level) Sorted DATE and TIME
  135.  3 - Top Uploaders Sorted by Kilobytes Uploaded
  136.  4 - Top Uploaders Sorted by Times Uploaded
  137.  5 - Top Troffers  Sorted by Kilobytes Downloaded
  138.  6 - Top Troffers  Sorted by Times Downloaded
  139.  7 - Top UL/DL Ratio (Kilobytes) Sorted by Ratio
  140.  8 - Top UL/DL Ratio (Times)     Sorted by Ratio
  141.  9 - Low UL/DL Ratio (Kilobytes) Sorted by Ratio
  142. 10 - Low UL/DL Ratio (Times)     Sorted by Ratio
  143. 11 - Top Message Writers
  144. 12 - Most Frequent Callers
  145. 13 - New Users Bulletin
  146. 14 - 15 Busiest Message Areas
  147. 15 - 15 Quietest Message Areas
  148.  
  149.  
  150. (Filepath and Name) is the Full path and name of the generated bulletin.
  151. There is no need to add .ANS or .ASC to the filename as this will be done
  152. by the program.
  153.  
  154. If Bulletin 14 or 15 is requested an additinal file which contains useful
  155. system information is generated in the current directory. This file is
  156. called FXSYSOP.BUL.
  157.  
  158.  
  159. Default : Number is REQUIRED
  160.           Path and Name will default to Current Directory + Bnn (eg. B1.ans)
  161.  
  162. Example : BULL 1 C:\RA\TEXT\BULLET1
  163.           Would generate the Last 10 Callers Bulletin and create two files
  164.           c:\ra\text\bullet1.ans AND c:\ra\text\bullet1.asc
  165. ────────────────────────────────────────────────────────────────────────────────
  166. DATEFMT (DDMMYY)
  167.  
  168. This parameter defines how dates are displayed in the bulletins.
  169. Three values are possible :- DDMMYY, MMDDYY, YYMMDD.
  170.  
  171. Default : MMDDYY
  172.  
  173. Example : DATEFMT DDMMYY    For dates in UK format.
  174. ────────────────────────────────────────────────────────────────────────────────
  175. SECLEVEL (number)
  176.  
  177. This parameter specifies the security level of users to be included in bulletin
  178. number two. Bulletin number 2 has a wide range of uses. :-
  179.  o Twit List (System Abusers)  (SECLEVEL 1 on my system)
  180.  o Co-Sysops List              (SECLEVEL 1000 on my system)
  181.  o Users Pending Verification  (SECLEVEL 18 on my system)
  182.  o Privileged Users            (SECLEVEL 31 on my system)
  183.  
  184. The "Users pending verification" is very useful to me as a sysop.
  185.  
  186. Default : 1
  187.  
  188. Example : SECLEVEL 10   ;First time unverified callers
  189. ────────────────────────────────────────────────────────────────────────────────
  190. BULLHEAD (number) (string of CHR$ [Max 30])
  191.  
  192. The Default heading for any bulletin can be changed with this parameter.
  193.  
  194. Default : (Depends on bulletin)
  195.  
  196. Example : BULLHEAD 2 Users Pending Verification
  197.           (Used in conjunction with SECLEVEL parameter)
  198. ────────────────────────────────────────────────────────────────────────────────
  199. BULLTERM (string of CHR$)
  200.  
  201. This parameter causes the string of CHR$ to be included as the last line
  202. of all generated bulletins. Typical use of this is to add the "CTRL A"
  203. character which will cause RA or QBBS to wait for [ENTER].
  204.  
  205. Default : None.
  206.  
  207. Example : Press [S] to stop or [ENTER] for next bulletin. ^A
  208.           note that ^A would not work. It MUST be the one byte ctrl a value
  209.           (character 1) to be effective.
  210. ────────────────────────────────────────────────────────────────────────────────
  211. BLACKLIST (user name)
  212.  
  213. The BLACKLIST parameter causes the program to ignore the named user.
  214. Useful for excluding the SYSOP from the bulletins.
  215.  
  216. Up to 3 BLACKLIST parameters are supported in this release.
  217.  
  218. Default : None
  219.  
  220. Example : BLACKLIST John Doe
  221. ────────────────────────────────────────────────────────────────────────────────
  222. BLACKMESS (board number)
  223.  
  224. The BLACKMESS parameter is similar in operation to the BLACKLIST parameter.
  225. It is only effective when generating the message base bulletins (14 or 15)
  226. and will cause the selected message board to be ignored when creating the 
  227. bulletin. Very useful for removing those sex and contacts private message
  228. areas that you don't want your users knowing about ;->
  229.  
  230. Default : None
  231.  
  232. Example : BLACKMESS 170
  233.           On My system this "blacklists" message board RA_SUPPORT.
  234. ────────────────────────────────────────────────────────────────────────────────
  235. COLOR[a] (number)
  236.  
  237. The COLOR parameter is used to define the colours used in the ANSI bulletin.
  238. The first character following the COLOR parameter selects which of the 7
  239. selectable elements are changed. The number selects the colour (0 to 7)
  240.  
  241. See the example configuration file for a full explanation.
  242.  
  243. Default : None
  244.  
  245. Example : COLORT 6
  246.           Title text (bbsname and bullname) in CYAN.
  247. ────────────────────────────────────────────────────────────────────────────────
  248. CLS (number)
  249.  
  250. This parameter causes the ANSI bulletin to clear the screen before displaying
  251. the bulletin. In addition the Background colour of the cleared screen will
  252. be set to the value (number).
  253.  
  254. Default : None
  255.  
  256. Example : CLS 0
  257.           Clear the screen with a black background colour.
  258. ──────────────────────────────────────────────────────────────────────────────── 
  259. FLAGS
  260.  
  261. Inclusion of this parameter in the config file causes FXBULL to generate a
  262. marker file "FXBULL.$$$" in the current directory.
  263.  
  264. NOTE that this file WILL NOT BE DELETED by FXBULL. You will have to delete
  265. it in the controlling batch file if you want to use this feature.
  266.  
  267. Purpose : To let other multi-line nodes know that FXBULL is already processing
  268.  
  269. Example : FLAGS  (Make this statement the very first one in the config file
  270.           to be effective.
  271.  
  272. Batch File:
  273. cd\ra\msgbase
  274. if exist fxbull.$$$ goto skipbull
  275. fxbull
  276. del fxbull.$$$
  277. :skipbull
  278. rem Last 10 Callers already being generated.
  279.  
  280. NOTE. In Multi-Line environments it is not a good move to copy the generated
  281. bulletin(s) to other files that may be locked because DOS will report a
  282. SHARE VIOLATION.  FXBULL is network compatible and will not suffer from these
  283. problems.
  284.  
  285. ────────────────────────────────────────────────────────────────────────────────
  286. Warranty :-
  287. -----------
  288.  
  289. No warranty of any kind (expressed or implied) is offered with this program.
  290. The author will not be responsible for any loss or damage caused through
  291. use of this program. You use this program at your own risk.
  292.  
  293.  
  294. Copyright :-
  295. ------------
  296.  
  297. Copyright Mark Alexander 1991. All Rights Reserved.
  298.  
  299.  
  300. Shareware :-
  301. ------------
  302.  
  303. This product is released under the Shareware principle. You may try this
  304. product for 30 days after which time you must register it.
  305. I'm not going to waste disk space telling you what shareware is. If you
  306. want to rip me off then go ahead. And may the fleas of a thousand camels
  307. infest your armpits!
  308.  
  309.  
  310. Registration :-
  311. ---------------
  312.  
  313. I'm glad you've decided to support this package. Your registration fee will
  314. make me feel a whole lot better about writing more goodies for the BBS
  315. community.
  316.  
  317. Send me your name and address with either :-
  318. A Five Pound Note (UK)
  319. A Ten Bucks Bill  (USA)
  320. Any Paper Money to the nearest equivalent value of Ten U.S. Dollars.
  321.  
  322. Registered users will receive the multi-line usage bulletin generator
  323. (see the example enclosed) free of charge. AND the program will stop
  324. making all those annoying noises!
  325.  
  326.  
  327. And now i'm going to have a nice cool beer!
  328. Greetings from Sunny London!
  329.  
  330. Mark Alexander.
  331. 31 Surlingham Close
  332. Thamesmead
  333. LONDON
  334. SE28 8NE
  335. ENGLAND
  336.  
  337. Fido: 2:440/52  (+44-81-310-6179)
  338.  
  339.